AcquireContainingPartProperties

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODPart

AcquireContainingPartProperties
The AcquireContainingPartProperties method should write into a storage unit the container properties this part associates with the specified embedded frame and then return the storage unit.
ODStorageUnit AcquireContainingPartProperties (
                                       in ODFrame frame);
frame
A reference to an embedded frame of this part.
return value
A reference to the storage unit that contains the container properties for the specified frame.

DISCUSSION
The part embedded in this part calls this method to request the container properties that this part associates with the embedded part's display frame.
Before returning the storage unit object, your part's AcquireContainingPartProperties method should call the storage unit object's Acquire method. When the caller has finished using the returned storage unit object, it should call the storage unit object's Release method.

OVERRIDING
When you subclass ODPart, you can override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely. This method needs to be implemented only by container parts.

EXCEPTIONS

kODErrCannotEmbed
This part does not support embedding.
kODErrInvalidFrame
The specified frame is not an embedded frame of this part.

SEE ALSO
The ODPart::ContainingPartPropertiesUpdated method (page 490).
Table 2-1 on page 89 in OpenDoc Programmer's Guide.
"Adopting Container Properties" on page 114 in OpenDoc Programmer's Guide.
"Transmitting Your Container Properties to Embedded Parts" on page 125 in OpenDoc Programmer's Guide.